/*
 * This file is part of the Sx Framework Library.
 * 
 * Copyright (C) 2013 University of Colorado Denver
 * <min.choi@ucdenver.edu> <shane.transue@ucdenver.edu>
 * 
 * Permission is hereby granted, free of charge, to any person obtaining a copy 
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 
 * copies of the Software, and to permit persons to whom the Software is 
 * furnished to do so, subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be included in 
 * all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 
 * DEALINGS IN THE SOFTWARE.
 */
#ifndef SX_LONG_H
#define SX_LONG_H

#include <ostream>

namespace Sx {

/*
 * The Long class provides a set of utility functions that are commonly
 * useful in the context of a complete library. This class provides a localized
 * library of conversion and parsing functions for basic longegering polong types.
 */
class Long {
public:
	Long();
	Long(const Long& l);

	/* Value Constructors */
	Long(long value);
	Long(float value);
	Long(double value);
	Long(short value);
	Long(int value);

	~Long();

	/*
	 * Sets the value of this longeger to the provided value.
	 */
	void set(long value);

	/*
	 * Returns the longernal longeger value stored in this Long.
	 */
	long data() const;

	/*
	 * Allows the longeral representation of this Long to be used as a native
	 * longeger value.
	 */
	operator long () const;

	/*
	 * Returns the maximum possible longeger value.
	 */
	static Long Max();

	/*
	 * Returns the minimum possible longeger value.
	 */
	static Long Min();

	/*
	 * Returns the symbolic value of infinity for a Long.
	 */
	static Long Infinity();

	/* Returns an unsigned long conversion of this longeger. */
	static unsigned long ToUnsignedLong(const Long& l);

	/* Operator Deflongions */
	Long operator + (const Long& l);
	Long operator + (long l);
	Long operator - (const Long& l);
	Long operator - (long l);
	Long operator * (const Long& l);
	Long operator * (long l);
	Long operator / (const Long& l);
	Long operator / (long l);
	void operator += (const Long& l);
	void operator += (long l);
	void operator -= (const Long& l);
	void operator -= (long l);
	void operator *= (const Long& l);
	void operator *= (long l);
	void operator /= (const Long& l);
	void operator /= (long l);
	void operator = (const Long& l);
	void operator = (long l);

	bool operator == (const Long& l);
	bool operator != (const Long& l);
	bool operator == (long l);
	bool operator != (long l);
	bool operator <= (const Long & l);
	bool operator <= (long l);
	bool operator >= (const Long & l);
	bool operator >= (long l);
	bool operator < (const Long & l);
	bool operator < (long l);
	bool operator > (const Long & l);
	bool operator > (long l);

	/* Global longeger addition operator */
	friend Long operator + (long v, const Long& l);
	friend Long operator - (long v, const Long& l);
	friend Long operator * (long v, const Long& l);
	friend Long operator / (long v, const Long& l);

	/* Provides basic stream ouput for the value of this Long. */
	friend std::ostream& operator << (std::ostream& out, const Long& l);

protected:
	long value;
};

}

#endif
